Create README.md #25
Draft
Create README.md #25
+82
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
atteggiani
requested changes
Mar 6, 2025
There was a problem hiding this comment.
Thank you @leoberhelman for working on this.
The structure looks good and the "TO BE ADDED" parts can be dealt with in the future.
Apart from the specific suggestions, as I mentioned in some comments, it might be useful to add some more detailed description and examples within each of the parsers.
README.md
Outdated
Comment on lines
20
to
24
| ### change_date.py | ||
| NEED TO ADD DESCRIPTION | ||
|
|
||
|
|
||
| Currently these files only operate on Dump files and include a work around to deal with the river field grids. |
There was a problem hiding this comment.
Suggested change
| ### change_date.py | |
| NEED TO ADD DESCRIPTION | |
| Currently these files only operate on Dump files and include a work around to deal with the river field grids. | |
| ### change_date | |
| Change the date of a UM restart file. | |
| Run `change_date --help` for detailed usage information. |
More information to be added within the parser, same as perturbIC
README.md
Outdated
| Currently these files only operate on Dump files and include a work around to deal with the river field grids. | ||
|
|
||
| ## Installation | ||
| DICUSS AT SOME POINT |
There was a problem hiding this comment.
Suggested change
| DICUSS AT SOME POINT | |
| TO BE ADDED |
README.md
Outdated
Comment on lines
29
to
50
| ## Usage | ||
|
|
||
| ```python | ||
| If the user wants to run perturbIC with a specific output filename | ||
| python perturbIC input_file_path -a 0.01 -s 2234 -o output_file_path | ||
|
|
||
| Otherwise it is optional perturbIC will create a filename from the input path | ||
| python perturbIC input_file_path -a 0.01 -s 2234 | ||
|
|
||
| The amplitude and seed are also optional as well | ||
| python perturbIC input_file_path -a 0.01 -s 2234 | ||
|
|
||
| To take a subset of field the user must provide a either a list of fields to exculde (-x) | ||
| python um_fields_subset.py input_file_path -x 155,156,3100,3101 | ||
|
|
||
| To take a subset of field the user must provide a either a list of fields to include (-v) | ||
| python um_fields_subset.py input_file_path -v 155,156,3100,3101 | ||
|
|
||
| Or you can choose to have the program to only include pronostics -p | ||
| python um_fields_subset.py input_file_path -p | ||
|
|
||
| These three options must be run seperately |
There was a problem hiding this comment.
Suggested change
| ## Usage | |
| ```python | |
| If the user wants to run perturbIC with a specific output filename | |
| python perturbIC input_file_path -a 0.01 -s 2234 -o output_file_path | |
| Otherwise it is optional perturbIC will create a filename from the input path | |
| python perturbIC input_file_path -a 0.01 -s 2234 | |
| The amplitude and seed are also optional as well | |
| python perturbIC input_file_path -a 0.01 -s 2234 | |
| To take a subset of field the user must provide a either a list of fields to exculde (-x) | |
| python um_fields_subset.py input_file_path -x 155,156,3100,3101 | |
| To take a subset of field the user must provide a either a list of fields to include (-v) | |
| python um_fields_subset.py input_file_path -v 155,156,3100,3101 | |
| Or you can choose to have the program to only include pronostics -p | |
| python um_fields_subset.py input_file_path -p | |
| These three options must be run seperately |
Examples like these should instead be included directly within the related parser, so they show up when <function> --help is run`.
Seperated the usage case
Add the usage for the change_dump_date
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Co-authored-by: Davide Marchegiani <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request handles the read me and the --help option with the specific instructions for singular functions